Index  Decision Records ISSUE-171: Dash as Marker for Unordered List

ISSUE-171: Dash as Marker for Unordered List

1 Status

Date Status
17-05-2026 Proposed
17-05-2026 Accepted
17-05-2026 Implemented

2 Context

Initially the only "*" markers were implemented in the Almirah Ruby gem for bullet lists (unordered lilsts). However Markdown format allows to use both "*" and "-" fur such purpose.

3 Decision

It would be good to add the support of "-" along as "*".

4 Scope

Item Status Start Date Target Date Description
Requirements Done 17-05-2026 17-05-2026 SRS-017 updated to allow "*" or "-" as the item marker
Code Done 17-05-2026 17-05-2026 Dash support added in doc_parser.rb and markdown_list.rb
Tests Done 17-05-2026 17-05-2026 Five new unit tests in doc_parser_spec.rb; <REQ> traces added for SRS-017, SRS-019, SRS-024

5 Out of Scope

Not identified

6 Consequences

6.1 Positive

6.2 Negative

Not identified.

6.3 Neutral

7 Alternatives Considered

No alternatives were considered

8 Proposed Changes

  1. Broaden the unordered-list entry-point regex in the document parser to match either * or - followed by a space.
  2. Update the MarkdownList.unordered_list_item? class method so list continuation lines starting with - are recognised.
  3. Extend the marker state in MarkdownList#calculate_text_position to treat - as a list-item marker alongside *.
  4. Add unit tests for - as a top-level marker, for mixed */- nested lists, and for - items with bold/italic formatting.
  5. Update the SRS-017 example to show that both * and - are valid unordered-list markers.
  6. Verify ADR-170 renders correctly after the change (it already uses - for its Positive / Negative / Neutral bullets).

9 Software Versions

Software Version Category Software Version ID
Latest Released Version 0.3.1
Issue Found in Version 0.3.1
Target Release Version 0.4.0

10 References

n/a

11 Review Evidences